Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
markdown-list-linter
Advanced tools
Lint markdown lists to warn when list items are not alphabetically ordered
Lints markdown lists and warn when list items are not alphabetically ordered.
This functionality is available to be consumed in three different ways:
⚡ A GitHub Action as part of your CI/CD process
📦 An NPM package that can be consumed in your JavaScript or TypeScript code
💻 A CLI that you can run in your terminal
You can install this package in your JavaScript or Typescript project.
npm install markdown-list-linter
Very simple to use, all results will be container in the returned object.
import { lintMarkdownList } from '../src/markdown-list-linter'
const results = lintMarkdownList('./path/to/markdown/file.md')
console.log(results)
When there are no errors, the returned object should look something like this. The property formattedMessage
is supplied if you need to print the output to a terminal console.
{
'summary': 'No errors found',
'formattedMessage': 'SUMMARY:\nNo errors found\n'
}
When there are errors, the returned object should look something like this.
{
'summary': 'Markdown list needs to be sorted',
'errorObject': [
{
'type': 'HEADINGS',
'message': 'Please correct the alphabetical order for these heading items',
'details': [
['C'],
['D', 'A']
],
},
{
'type': 'LIST_ITEMS',
'message': 'Please correct the alphabetical order for these list items',
'details': [
[
`[African Buffalo]('https://www.AfricanBuffalo.com')`,
`[Aardwolf]('https://www.Aardwolf.com')`
]
],
}
],
'formattedMessage': "SUMMARY:\nMarkdown list needs to be sorted\n\nDETAILS:\nPlease correct the alphabetical order for these heading items\n\tSection #1\n\t\tD\n\t\tA\n\t\tB\n\t\tC\n\nPlease correct the alphabetical order for these list items\n\tSection #1\n\t\t[African Buffalo]('https://www.AfricanBuffalo.com')\n\t\t[Aardwolf]('https://www.Aardwolf.com')\n\n\"
}
The array items in the details
object is sections in the list which need to be reordered.
FAQs
Lint markdown lists to warn when list items are not alphabetically ordered
The npm package markdown-list-linter receives a total of 1 weekly downloads. As such, markdown-list-linter popularity was classified as not popular.
We found that markdown-list-linter demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.